[2.x] docs: Document incOptions.properties in scripted tests (#284) - #1756
Merged
eed3si9n merged 2 commits intoAug 11, 2026
Merged
Conversation
eed3si9n
reviewed
Jul 26, 2026
Member
There was a problem hiding this comment.
Thanks for the contribution!
For symmetry with sbt/sbt, could you move this to contributing-docs/scripted_tests.md please, and maybe a small zinc/src/sbt-test/README.md that points to it. I've been thinking that I need to copy sbt/sbt's contributing-docs to Zinc.
eed3si9n
approved these changes
Aug 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #284.
Adds
zinc/src/sbt-test/README.mddocumenting the scripted test layout and theincOptions.propertiesformat, linked from CONTRIBUTING.md.Keys are split three ways, since parsing a key is not the same as honouring it: keys that take effect (with the scripted default, which differs from the
IncOptionsdefault forapiDebug,pipelining,recompileAllFraction), keys parsed but never observed (classfileManagerType,transactionalManagerBaseDirectory,allowMachinePath,apiDumpDirectory,ignoredScalacOptions), andIncOptionsfields with no key.Also notes the file is read once at project init, so mid-script copies of it do nothing.